Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #769

Merged
merged 42 commits into from Aug 3, 2020
Merged

Documentation #769

merged 42 commits into from Aug 3, 2020

Conversation

aogriffiths
Copy link
Contributor

Hi,

I've made lots of improvements to the documentation. It would be great if you would like to merge these in.

Thanks
Adam

aogriffiths and others added 19 commits July 13, 2020 09:22
(home-assistant#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
home-assistant#768 (comment)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
(home-assistant#768 (comment))
- Surround headings with newlines
- ODROID
- Use dashes for unordered lists

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
- new line after heading
(home-assistant#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
- \- for unordered lists
- new line after heading
(home-assistant#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
- new line after heading
- \- for unordered lists
(home-assistant#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
@aogriffiths
Copy link
Contributor Author

This PR should be good to for you to review now. It can come after #768 or replace it.

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really like this revamp, contains a few changes I was thinking of too!

Documentation/boards/hardkernel/odroid-xu4.md Outdated Show resolved Hide resolved
Documentation/boards/hardkernel/odroid-xu4.md Outdated Show resolved Hide resolved
Documentation/boards/hardkernel/odroid-xu4.md Outdated Show resolved Hide resolved
Documentation/boards/intel/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@aogriffiths aogriffiths requested a review from agners July 23, 2020 20:37
@aogriffiths
Copy link
Contributor Author

hi @agners I think I've resolved all of your comments / suggestions.

@aogriffiths aogriffiths requested a review from agners July 24, 2020 09:52
@pvizeli pvizeli merged commit 0283652 into home-assistant:dev Aug 3, 2020
pvizeli added a commit that referenced this pull request Aug 3, 2020
* spelling correction

* Restuctured, added "features", "supported hardware", intro for developers and links to the developer documentation.

* Spelling correction

* URL correction

* Documentation restructure

* Moving developer documentation index from top level README to Documentation directory README

* fixing URLS

* Restructuring and adding to board config

* Improving navigation of docs oon github

* New line after first heading

(#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

#768 (comment)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

(#768 (comment))
- Surround headings with newlines
- ODROID
- Use dashes for unordered lists

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- new line after heading
(#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- \- for unordered lists
- new line after heading
(#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- new line after heading
- \- for unordered lists
(#768 (comment))

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Spelling correction, to ensure /Dpcumentation/kernel.mdhas the correct spelling

* capitalisation

* using - for unordered lists

* Adding links to config files

* fixing links to _defconfig files

* fixing link for rpi0_w

* fixing link for rpi3_64 and rpi4_64

* making the ova README consistent with the others

* formmating

* fixing numbered list

* fixing indent for sub-bullets

* questions regarding Tinker S and OVA support

* resolving PR comment from fabaff

* resolving PR comment from fabaff

* #769

* Changing uBoot to U-Boot (#769 (comment))

* s/boot sector/eMMC boot partition/ (See #769 (comment))

* As per comments here:
#769 (comment)
#769 (comment)

* HassOS is no longer the official name (#769 (comment))

* Should be Home Assistant Operating System (or OS) (see https://community.home-assistant.io/t/changing-the-home-assistant-brand/167500/16). See also commennts here #769 (comment), taken in to account along with previous comments about this paragraph.

* s/HassOS/Home Assistant Operating System/

* 8Gb Pi 4 will be supported soon (see comment #769 (comment))

* resolving conflict with main dev branch.

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Pascal Vizeli <pvizeli@syshack.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants